package com.zenithmind.exam.service;

import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.baomidou.mybatisplus.extension.service.IService;
import com.zenithmind.exam.pojo.entity.QuestionFavorite;
import com.zenithmind.exam.pojo.vo.QuestionVO;

import java.util.List;

/**
 * 题目收藏服务接口
 * 
 * @author ZenithMind
 * @since 2024-07-01
 */
public interface QuestionFavoriteService extends IService<QuestionFavorite> {

    /**
     * 收藏题目
     * 
     * @param userId 用户ID
     * @param questionId 题目ID
     * @return 收藏结果
     */
    boolean favoriteQuestion(String userId, String questionId);

    /**
     * 取消收藏题目
     * 
     * @param userId 用户ID
     * @param questionId 题目ID
     * @return 取消收藏结果
     */
    boolean unfavoriteQuestion(String userId, String questionId);

    /**
     * 检查用户是否收藏了指定题目
     * 
     * @param userId 用户ID
     * @param questionId 题目ID
     * @return 是否收藏
     */
    boolean isFavorited(String userId, String questionId);

    /**
     * 获取用户收藏的题目列表
     * 
     * @param userId 用户ID
     * @return 收藏的题目列表
     */
    List<QuestionVO> getUserFavoriteQuestions(String userId);

    /**
     * 分页查询用户收藏的题目
     * 
     * @param page 分页参数
     * @param userId 用户ID
     * @return 分页结果
     */
    IPage<QuestionVO> getUserFavoriteQuestionPage(Page<QuestionFavorite> page, String userId);

    /**
     * 统计用户收藏的题目数量
     * 
     * @param userId 用户ID
     * @return 收藏数量
     */
    Integer countUserFavorites(String userId);

    /**
     * 统计题目被收藏的次数
     * 
     * @param questionId 题目ID
     * @return 收藏次数
     */
    Integer countQuestionFavorites(String questionId);

    /**
     * 获取最受欢迎的题目
     * 
     * @param limit 限制数量
     * @return 最受欢迎的题目列表
     */
    List<QuestionVO> getMostFavoritedQuestions(Integer limit);

    /**
     * 清空用户的所有收藏
     * 
     * @param userId 用户ID
     * @return 清空结果
     */
    boolean clearUserFavorites(String userId);

    /**
     * 批量收藏题目
     * 
     * @param userId 用户ID
     * @param questionIds 题目ID列表
     * @return 批量收藏结果
     */
    boolean batchFavoriteQuestions(String userId, List<String> questionIds);

    /**
     * 批量取消收藏题目
     * 
     * @param userId 用户ID
     * @param questionIds 题目ID列表
     * @return 批量取消收藏结果
     */
    boolean batchUnfavoriteQuestions(String userId, List<String> questionIds);

    /**
     * 获取用户收藏的题目ID列表
     * 
     * @param userId 用户ID
     * @return 题目ID列表
     */
    List<String> getUserFavoriteQuestionIds(String userId);
}
